Update App Environment

Updates the name or description of an existing app environment.

PUT{accelqLoginUrl}/awb/api/2.0/{tenantCode}/{projectCode}/conf/app-environments/{appEnvironmentId}

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`projectCode`	string	Yes	Project Code found under Auth properties of ACCELQ User Profile
`appEnvironmentId`	integer	Yes	The ID of the App Environment to update.
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Request Body

json

{
  "pid": 15754,
  "appEnvironmentName": "Updated App Environment",
  "description": "Updated description"
}

Responses

200 - App Environment successfully updated.

json

{
  "pid": 15754,
  "appEnvironmentName": "Updated App Environment",
  "description": "Updated description"
}

400 - Bad Request. Validation errors occurred.

json

{
  "error": "App environment name is required."
}

422 - App Environment or Project not found.

json

{
  "error": "App environment with ID '15754' not found."
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

projectCode (string) *

appEnvironmentId (integer) *

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X PUT "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/${{projectCode}}/conf/app-environments/${{appEnvironmentId}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "pid": 15754,
  "appEnvironmentName": "Updated App Environment",
  "description": "Updated description"
}'